gh-151943: Fix incorrect interface names in xml.sax.rst#151961
gh-151943: Fix incorrect interface names in xml.sax.rst#151961manoj-marimuthu wants to merge 5 commits into
Conversation
Documentation build overview
59 files changed ·
|
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
As for create_parser, please add a reference (.. _sax-parser-modules:) to the note at the top of the xml.sax.reader documentation. We can then expand that note.
| and :class:`~xml.sax.xmlreader.XMLReader` interfaces are defined in the | ||
| module :mod:`xml.sax.xmlreader`. The handler interfaces are defined in | ||
| :mod:`xml.sax.handler`. For convenience, | ||
| :class:`~xml.sax.xmlreader.AttributesImpl`, |
There was a problem hiding this comment.
These should instead link to :ref:`Attributes <attributes-objects>` and :ref:`AttributesNS <attributes-ns-objects>`.
…r modules in xml.sax.rst and xml.sax.reader.rst respectively
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
You didn't actually fix the issue with create_parser? Please change it to a reference as I noted before. You should then be able to remove the file from .nitignore.
| :class:`~xml.sax.xmlreader.InputSource` (which is often | ||
| instantiated directly) and the handler classes are also available from | ||
| :mod:`!xml.sax`. These interfaces are described below. | ||
| :ref:`Attributes <attributes-objects>`,:ref:`AttributesNS <attributes-ns-objects>`, |
| :mod:`!xml.sax`. These interfaces are described below. | ||
| :ref:`Attributes <attributes-objects>`,:ref:`AttributesNS <attributes-ns-objects>`, | ||
| and :class:`~xml.sax.xmlreader.XMLReader` interfaces are defined in the module | ||
| :mod:`xml.sax.xmlreader`. The handler interfaces are defined in |
There was a problem hiding this comment.
Please keep double spacing for consistency.
|
@StanFromIreland I believe I have added the reference now, I am new to sphinx. |
2 participants
The following PR addresses aims to remove the warnings from sphinx that are raised for
xml.sax.rst. (total 3 warnings)Warnings removed:
xml.sax.xmlreader.Attributeswithxml.sax.xmlreader.AttributesImplandxml.sax.xmlreader.AttributesNSwithxml.sax.xmlreader.AttributesNSImpl.Verification :
xml.sax.xmlreader.AttributesImpl: xml.sax.reader.rstxml.sax.xmlreader.AttributesNSImpl: xml.sax.reader.rstWarnings remaining:
create_parserfunction. We can either add documentation for it or remove the documentation's reference tocreate_parser. Waiting for suggestions.Doc/library/{xml*,pyexpat}.rst#151943